Add docs for sending plugin messaging#84
Conversation
|
I would like to see if you could perhaps include the built in bungee types (as we still have to go to the spigot forums for those) and lastly how to actually listen to and send plugin messages on the proxy as well. As currently it seems to only really describe how it is on the server, more in depth than the proxy id argue. |
|
|
||
| ## Sending Plugin Messages | ||
|
|
||
| First, we're actually going take a look at your Java server. Your Java server plugin will need to register that it will be sending on any given plugin channel. You'll should to do this alongside your other event listener registrations. |
There was a problem hiding this comment.
Java server? why not paper server? lol
alternatively, backend server works too I guess, but java server seems just weird.
e-im
left a comment
e-im
left a comment
There was a problem hiding this comment.
This feels like it would work significantly better as two separate but intertwined guides— one in the Paper section focusing on how to send and receive on plugin channels more generally, possibly also mentioning their characteristics (they piggyback off of player connections, so won't work without a player online), and then one in the Velocity section talking about first the BungeeCord compatibility aspect as outlined here, as well as how Velocity plugins can send and receive messages on plugin channels.
For the Paper section, I wouldn't at all talk about bungeecord:main or proxy specifics, but instead link to the description of that in the Velocity guide.
I totally see why you put this in the Velocity section, but I don't think it makes sense without expansion. I'd also like to if at all possible keep the Velocity section free of Bukkit specific examples- as Velocity is compatible with and supports much more.
This is just an idea/my opinion, though, so feel free to do it or not if you disagree.
|
Perhaps include how to register custom channels & custom messages (also on Velocity side). |
|
Superseded by 16f8ede. |
7 participants
Saw an uptick in people asking about Plugin Messaging and figured it was kinda weird to send new devs to the Spigot Wiki.
Obviously my first time contributing to the docs here, but I've decided put it under the Velocity section of the docs but all the code samples use the Bukkit API. Mostly because we don't have a Paper How-To Section (pending #83?!).
I intended on keeping it vague, but didn't want to lose focus on the proxy so this didn't become a Paper guide. However, I'm confident in this as a starting point and would love some ideas/feedback especially as I learn to develop the Paper tone of voice. In the future I'd be open to writing more "how-to" style docs like this one.